<!--
/**
 * @file Installation.html
 * @author Alejandro Dario Simi
 * @date $Date: 2012-12-28 01:08:14 +0000 (Fri, 28 Dec 2012) $
 *
 * $Id: Installation.html 47 2012-12-28 01:08:14Z daemonraco@gmail.com $
 * $URL: http://wcomix.googlecode.com/svn/tags/wcomix-1.0.0.2/docs/Installation.html $
 */
-->
<html>
	<head>
		<title>Installation</title>
		<link rel="stylesheet" type="text/css" href="docs.css"/>
		<script type="text/javascript" src="jquery-1.8.0.min.js"></script>
		<script type="text/javascript" src="docs.js"></script>
	</head>
	<body>
		__TOC__
		<div class="Section">
			<span class="Title">Step 0</span>
			<div class="Paragraph">
				<p>This is the initial step in the installation process. It checks for some basic permission needed to continue.</p>
				<p>These checks are:</p>
				<p><ul>
					<li><label></label>[VA:$wcROOTDIR]/cache</label>: Checks for existens and read/writting access.</li>
					<li><label></label>[VA:$wcROOTDIR]/cache/expanded</label>: Checks for existens and read/writting access.</li>
					<li><label></label>[VA:$wcROOTDIR]/cache/thumbs</label>: Checks for existens and read/writting access.</li>
				</ul></p>
				<p>The read/write permissions for '[VA:$wcROOTDIR]/cache' are required for two reasons. First of all, the installation process uses
				it to save temporary data. Also, wcomix uses these directories to store expanded comics and thumbnails, and because this is dynamic,
				it needs permission to write inside them.</p>
			</div>
		</div>
		<div class="Section">
			<span class="Title">Step 1</span>
			<div class="Paragraph">
				<p>This step presents a form to input the database connection data. With this information, this step will try to connect to database
				and if it's correct it will allow to procced further in the installation process.</p>
				<p>The required data will be:</p>
				<p><ul>
					<li><label>Server</label>: Server name where the database is running. It's not necesary to be the same hostname as server
					where the page is running.</li>
					<li><label>Database Name</label>: This is the name asigned to the databases to be used.</li>
					<li><label>Tables Prefix</label>: This value is a short text to prepend on every table name. It can be useful where wcomix
					tables share the same database with other tables.</li>
					<li><label>Database Username</label>: Name of the user with permissions to access and modify the database (with DDL and DML
					access).</li>
					<li><label>Database Password</label>: Password for the user of the previous point.</li>
				</ul></p>
			</div>
		</div>
		<div class="Section">
			<span class="Title">Step 2</span>
			<div class="Paragraph">
				<p>The step two, also known as "the first group", presents a form for the creation of a group of comics.</p>
				<p>By default, wcomix needs at least one group configured in the datadabe, for that reason, this step asks some basic values in order
				to create a new group and insert its configuration into database. Also, the id of this new group will be added to local configuration
				as a default group into {VA:$wcDefaults['group']}.</p>
				<p>The required data will be:</p>
				<p><ul>
					<li><label>Group Name</label>: Name to be asigned to the new group. By default this parameter presents the value [CO:My
					Comics], but it can be change.</li>
					<li><label>Group Directory</label>: This must be a full path inside the server where wcomix is being installed. This path will
					be taken as root path for the new group and used every time an element of this group must be referenced.<br/>
					In the future, if this path needs to be relocated for any reason, it will only need a change in the group configuration and it
					will point to the new path.</li>
					<li><label>[OL:Group Trash Directory]</label>: This is a path inside the groups root path where the garbage will be store.
					This mean that every comic tagged with de trash-tag will be move to it where the wcomix cron is run. Such tag is an special
					one configured by the variable {VA:$wcSpecialTags['TRASH']}.<br/>
					If this field is left empty, the new group will be created with trash can and the trash-tag will be used as a simple tag.<br/>
					From now on, the administrator must remember that every directory path inside a group must start with slash as if every
					path is a full one. This is because all groups as their own "root" path.</li>
				</ul></p>
			</div>
		</div>
		<div class="Section">
			<span class="Title">Step 3</span>
			<div class="Paragraph">
				<p>In here, the installation process will ask for some default configuration. This options will be presented inside a form with their
				recommended values, but they can be changed as the installation operator sees fit.</p>
				<p>The required option for default values will be:</p>
				<p><ul>
					<li><label>Use page cache system</label>: wcomix provides a mechanism to cache page in the database decreasing the
					response time of each page.</li>
					<li><label>Allow public groups for anonymous users</label>: This option allow to disable access to public groups for any user
					that is not logged.</li>
					<li><label>Maximum session duration (in seconds)</label>: This parameter will set a maximum number of seconds while a session
					will stay alive without usage. By default, it's set to 86400 seconds <span title="numbers! numbers!">which means 24
					hours</span>.</li>
					<li><label>Home page</label>: This is the page to be shown when the site is called without a specific action or when the
					"Home" link is pressed.</li>
				</ul></p>
			</div>
		</div>
		<div class="Section">
			<span class="Title">Step 4</span>
			<div class="Paragraph">
				<p>This step will attempt to generate the local configuration file based on previous steps. After it is created, the installation
				operator will be asked to move this generated file to its right location before a further step can be reached.</p>
			</div>
		</div>
		<div class="Section">
			<span class="Title">Step 5</span>
			<div class="Paragraph">
				<p>This step is directly related to step 2 and the creation of the first group. For similar reasons, all groups require at least one
				directory configured, that's why this step will ask to choose which directories have to be added. All suggested directories will be
				listed from the new group's root directory.</p>
				<p>The interfase will show the directory "/" (slash) selected and disabled for changes, this behavior will force to add the group's
				root directory in the configuration.</p>
			</div>
		</div>
		<div class="Section">
			<span class="Title">Step 6</span>
			<div class="Paragraph">
				<p>By default, there are two essencial users for a correctly installed wcomix site:<ul>
					<li>[CO:root]: Administration user.</li>
					<li>[CO:cron]: Cron tasks user, also administrator.</li>
				</ul></p>
				<p>This step will create theses users with basic information promptting their default password (which will be the same as the
				username).</p>
			</div>
		</div>
		<div class="Section">
			<span class="Title">Final Step</span>
			<div class="Paragraph">
				<p>The final step has two part. The first one will require to run the wcomix cron at least one time. After that is done, it will
				remove all temporary files created by the installation process and provide a button to access the new site.</p>
			</div>
		</div>
	</body>
</html>
